vcProcessFlowGroupManager

The flow group manager is used to create, access and delete the process flow groups within its owner process controller.

See in: Overview

Module: vcProcessModel

Parent: vcObject

Children -

Referenced by: vcProcessController.FlowGroupManager

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

NameTypeAccessDescription
GroupsvcObservableList[vcProcessFlowGroup]RGets the list of all registered flow groups.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

NameReturn TypeParametersDescription
clearGroupsNoneNoneDeletes all groups.
createGroupvcProcessFlowGroupString groupNameCreates a new group with the given name.
See more
Parameters:
groupName (String): Group name. The name must be unique within the process controller.

Returns:
vcProcessFlowGroup: newly created process flow group.

Exceptions:
ValueError: When given group name is empty or not unique.
findGroupvcProcessFlowGroupString groupNameFinds a flow group with the given name.
See more
Parameters:
groupName (String): Group name.

Returns:
vcProcessFlowGroup: found process flow group, None if not found.
moveProductTypeNonevcProductType productType,
vcProcessFlowGroup target
Tries to move the given product type to the given target group.
See more
Parameters:
typeToMove (vcProductType): Product type.
destination (vcProcessFlowGroup): Target group.

Exceptions:
ValueError: When type to move is 'Any' product type.